ansi-styles

What is ansi-styles?

The ansi-styles package provides a collection of ANSI escape codes for styling strings in the terminal. These codes can be used to add color, background color, and various text styles such as bold, italic, underline, etc., to console output.

What are ansi-styles's main functionalities?

Color

This feature allows you to apply text color to your strings. The code sample demonstrates how to color the text 'Hello world!' in green.

const ansiStyles = require('ansi-styles');
console.log(`${ansiStyles.green.open}Hello world!${ansiStyles.green.close}`);

Background Color

This feature allows you to apply background color to your strings. The code sample demonstrates how to set the background color of the text 'Hello world!' to blue.

const ansiStyles = require('ansi-styles');
console.log(`${ansiStyles.bgBlue.open}Hello world!${ansiStyles.bgBlue.close}`);

Text Styles

This feature allows you to apply text styles like bold, italic, underline, etc. The code sample demonstrates how to make the text 'Hello world!' bold.

const ansiStyles = require('ansi-styles');
console.log(`${ansiStyles.bold.open}Hello world!${ansiStyles.bold.close}`);

Other packages similar to ansi-styles

chalk

Chalk is a popular npm package that allows you to style terminal strings. It is more user-friendly than ansi-styles as it provides a chainable API and template literal support, making it easier to combine styles.

colors

Colors is another npm package for adding colors to terminal output. It extends String.prototype to add color properties, allowing for a syntax like 'Hello world!'.green. It is less explicit than ansi-styles and can lead to conflicts with other String prototype extensions.

cli-color

CLI-color is a package for creating colored CLI output. It offers a similar feature set to ansi-styles but also includes additional functionality for cursor movement and window size detection.

README

ansi-styles

ANSI escape codes for styling strings in the terminal

You probably want the higher-level chalk module for styling your strings.

Install

$ npm install --save ansi-styles

Usage

var ansi = require('ansi-styles');

console.log(ansi.green.open + 'Hello world!' + ansi.green.close);

API

Each style has an open and close property.

Styles

Modifiers

• reset
• bold
• dim
• italic (not widely supported)
• underline
• inverse
• hidden
• strikethrough (not widely supported)

Colors

• black
• red
• green
• yellow
• blue
• magenta
• cyan
• white
• gray

Background colors

• bgBlack
• bgRed
• bgGreen
• bgYellow
• bgBlue
• bgMagenta
• bgCyan
• bgWhite

Advanced usage

By default you get a map of styles, but the styles are also available as groups. They are non-enumerable so they don't show up unless you access them explicitly. This makes it easier to expose only a subset in a higher-level module.

• ansi.modifiers
• ansi.colors
• ansi.bgColors

Example

console.log(ansi.colors.green.open);

License

MIT © Sindre Sorhus